Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: local setup notes #5974

Merged
merged 1 commit into from
Jun 30, 2024
Merged

docs: local setup notes #5974

merged 1 commit into from
Jun 30, 2024

Conversation

danstarns
Copy link
Member

This PR adds notes about setting up the repo locally and making some assumptions about the dev flow of other contributors.

Related discussion:

This is a Node.js project and you need to have Node.js installed on your machine. You can download it from [here](https://nodejs.org/). We test versions 14 and 16 of Node in the CI, so it's recommended to use one of these versions, or the latest of: 16.20.2

```bash
nvm use 16.20.2
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RE discussion, we should use this version locally to ensure consistent machine to CI.

16.20.2 comes from the latest 16 in https://nodejs.org/en/about/previous-releases and satisfies the node-version: [14.17, 16.x] matrix in the CI test runner.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙇‍♂️
Based on the releases, we should probably switch to [20.x, 22.x] soon.

@artf
Copy link
Member

artf commented Jun 30, 2024

Nice addition @danstarns Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants